home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / remote / race200.zip / RACEEDIT.DOC < prev    next >
Text File  |  1993-02-27  |  6KB  |  120 lines

  1.  
  2.                           RACEEDIT.EXE
  3.  
  4. RACEEDIT is a simple full screen editor that will allow you to write a
  5. message to a user from within RACE.  RACEEDIT does not have block
  6. commands or search and replace or any other fancy do-dads.  It's
  7. a basic editor that will allow you to write a quick message to a
  8. user.  If you would like to use your own editor, see the technical
  9. notes in the second half of this document.
  10.  
  11. Place RACEEDIT.EXE in the same directory as RACE.EXE.  From within the
  12. RACE main screen, press ALT-E to bring up the message editor.  If you
  13. are a registered RACE user, ALT-E will also bring up the editor in the
  14. validation screen.  If you are not registered, "Unavailable in
  15. unregistered version" is displayed if you press ALT-E in validate.
  16.  
  17. Also available in the registered version of RACE in validation, ALT-W
  18. will load RACEEDIT with the current answer set in quoted form.
  19.  
  20. RACEEDIT is executed directly from with RACE and command.com is not
  21. used.  Whether or not RACE swaps out before running RACEEDIT is
  22. determined by your settings for Swap file in RACECFG.  See RACE.DOC for
  23. full information on the swap file set up.
  24.  
  25. RACEEDIT gets most of the message header information from the welcome
  26. message configuration set up in RACECFG.  The TO: field is filled with
  27. the name of the user currently being viewed in the main screen or in
  28. validate mode if registered as previously mentioned.
  29.  
  30. The lack of ability to edit header information was a design decision
  31. meant to prevent accidental posting of messages to non-existant users,
  32. in message boards where they shouldn't go (echomail), undefined boards,
  33. etc.  The primary purpose of the built in editor is for use during
  34. validation and so using the welcome message set up information was felt
  35. to be the best and safest way to go.
  36.  
  37. RACEEDIT will allow creation of a message up to 64k in length or
  38. available memory, whichever is the lesser of the two.
  39.  
  40. <F1> while in RACEEDIT will give you a help screen containing the full
  41. list of available commands.
  42.  
  43.  
  44. Technical information
  45. ---------------------
  46.  
  47. RACEEDIT.EXE is basically a Turbo Professional TpMemo editor that was
  48. written specifically to work with RACE.
  49.  
  50. You CANNOT simply rename your favorite editor to RACEEDIT.EXE and use it
  51. in place of the supplied editor.  This was not done intentionally to
  52. prevent using a different editor.  One reason for this is that the best
  53. method of determining what RACE should do next on return from running the
  54. editor is by examining the errorlevel the editor has dropped.  Most
  55. editors don't drop an errorlevel upon exit and if they do, they probably
  56. won't match what RACE needs to know.  The following errorlevels are
  57. defined in RACEEDIT.EXE:
  58.  
  59.       0 = normal termination, message text saved
  60.       1 = normal termination, message text NOT saved
  61.       2 = window error (probably insufficient heap space)
  62.       3 = error writing message file
  63.       4 = error reading message file
  64.       5 = buffer allocation or memory error
  65.  
  66. The first two errorlevels are obviously the most important and if you
  67. have an editor that can drop those under the proper conditions, you MAY
  68. be able to use it in place of RACEEDIT.  Note that most editors will
  69. probably (?) return an errorlevel of 0 no matter what happens short of
  70. the editor crashing.  If that is the case, RACE may attempt to import
  71. the text file even if you aborted the save in your editor.  More on this
  72. later.
  73.  
  74. The next thing you need to know is that RACEEDIT writes any saved text
  75. to a file called RACETMP.MSG.  This is the filename RACE will look for
  76. if an errorlevel of 0 is returned when exiting the editor.  Once this
  77. file is successfully imported, RACE deletes it.
  78.  
  79. Another thing to keep in mind is that RACEEDIT saves the underlying
  80. screen before it pops up and restores it upon exit.  If your editor
  81. doesn't do this, it could get messy looking.
  82.  
  83. I have tested RACE with Qedit by renaming Qedit.exe to RACEEDIT.EXE and
  84. it does work for the most part.  Even though RACEEDIT does not need the
  85. text file name passed to it, RACE passes 'RACETMP.MSG' for the use
  86. of other editors.  By providing this, you won't have to answer your
  87. editor's prompt for a filename everytime you want to write a message.
  88.  
  89. You will probably need the registered version of Qedit because I believe
  90. the unregistered version does not save the underlying screen.  Although
  91. RACE updates all the information after any action, it does NOT redraw
  92. the entire screen and as mentioned before, it might not be pretty if
  93. your editor doesn't save the screen.
  94.  
  95. Next you will need to rename QEDIT.EXE to RACEEDIT.EXE and place it in
  96. the same directory as RACE.  Future versions of RACE may allow you to
  97. define the editor name, but for now "RACEEDIT.EXE" is hard coded into
  98. RACE.
  99.  
  100. When using Qedit with RACE =YOU= will have to be sure you don't save
  101. any text if you wish to abort the message.  QEDIT will not create
  102. RACETMP.MSG until you save or save and exit so RACE will be able to
  103. tell there is nothing to import if you leave Qedit properly.
  104.  
  105. Since Qedit doesn't drop the same (or any?) errorlevels as the real
  106. RACEEDIT, the only way RACE can tell the message was aborted is by the
  107. absence of RACETMP.MSG.  If it finds this file it =WILL= import it if
  108. you are using an editor other than the 'official' RACEEDIT.
  109.  
  110. Last but not least, you will have to insure the margins within Qedit are
  111. reasonable.  RACE imports the message text as is with absolutely NO
  112. formatting.  Set your right margin to 65 or 70 and all should be fine.
  113.  
  114. The above procedures may or may not work with other editors.  You'll
  115. just have to experiment a bit.
  116.  
  117.  
  118.                                 ** EOF **
  119.  
  120.